<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FLITr: flitr::FFmpegProducer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">FLITr
   &#160;<span id="projectnumber">1.x</span>
   </div>
   <div id="projectbrief">Framework for Live Image Transformation.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classflitr_1_1_f_fmpeg_producer.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classflitr_1_1_f_fmpeg_producer-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">flitr::FFmpegProducer Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="ffmpeg__producer_8h_source.html">ffmpeg_producer.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for flitr::FFmpegProducer:</div>
<div class="dyncontent">
<div class="center"><img src="classflitr_1_1_f_fmpeg_producer__inherit__graph.png" border="0" usemap="#flitr_1_1_f_fmpeg_producer_inherit__map" alt="Inheritance graph"/></div>
<map name="flitr_1_1_f_fmpeg_producer_inherit__map" id="flitr_1_1_f_fmpeg_producer_inherit__map">
<area shape="rect" id="node2" href="classflitr_1_1_image_producer.html" title="{flitr::ImageProducer\n|# ImageFormat_\l# SharedImageBuffer_\l# CreateMetadataFunction_\l|+ ImageProducer()\l+ ~ImageProducer()\l+ init()\l+ getFormat()\l+ getNumWriteSlotsAvailable()\l+ trigger()\l+ seek()\l+ getLeastNumReadSlotsAvailable()\l+ setCreateMetadataFunction()\l# releaseReadSlotCallback()\l# addConsumer()\l# reserveWriteSlot()\l# releaseWriteSlot()\l}" alt="" coords="5,5,240,333"/></map>
</div>
<div class="dynheader">
Collaboration diagram for flitr::FFmpegProducer:</div>
<div class="dyncontent">
<div class="center"><img src="classflitr_1_1_f_fmpeg_producer__coll__graph.png" border="0" usemap="#flitr_1_1_f_fmpeg_producer_coll__map" alt="Collaboration graph"/></div>
<map name="flitr_1_1_f_fmpeg_producer_coll__map" id="flitr_1_1_f_fmpeg_producer_coll__map">
<area shape="rect" id="node2" href="classflitr_1_1_image_producer.html" title="{flitr::ImageProducer\n|# ImageFormat_\l# SharedImageBuffer_\l# CreateMetadataFunction_\l|+ ImageProducer()\l+ ~ImageProducer()\l+ init()\l+ getFormat()\l+ getNumWriteSlotsAvailable()\l+ trigger()\l+ seek()\l+ getLeastNumReadSlotsAvailable()\l+ setCreateMetadataFunction()\l# releaseReadSlotCallback()\l# addConsumer()\l# reserveWriteSlot()\l# releaseWriteSlot()\l}" alt="" coords="5,5,240,333"/></map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3a8f41dd8282de8faaef2d4fa580977e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a3a8f41dd8282de8faaef2d4fa580977e">FFmpegProducer</a> (std::string filename, <a class="el" href="classflitr_1_1_image_format.html#a2bab1cfeef716117996a75550577efdc">ImageFormat::PixelFormat</a> out_pix_fmt, uint32_t buffer_size=<a class="el" href="shared__image__buffer_8h.html#aac634152527964baab3ef9b764174e68">FLITR_DEFAULT_SHARED_BUFFER_NUM_SLOTS</a>)</td></tr>
<tr class="memitem:abef2ab1f44dc9fb5a0a351656c61b0fd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#abef2ab1f44dc9fb5a0a351656c61b0fd">setAutoLoadMetaData</a> (std::tr1::shared_ptr&lt; <a class="el" href="classflitr_1_1_image_metadata.html">ImageMetadata</a> &gt; defaultMetadata)</td></tr>
<tr class="memitem:a7b690142fd60cd615253bff0fb0f3ebc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a7b690142fd60cd615253bff0fb0f3ebc">init</a> ()</td></tr>
<tr class="memitem:a2dd4099b87c7bc4e3593c54d972139a2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a2dd4099b87c7bc4e3593c54d972139a2">trigger</a> ()</td></tr>
<tr class="memitem:a5dcce214520a811994878e2ed32d91a7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a5dcce214520a811994878e2ed32d91a7">seek</a> (uint32_t position)</td></tr>
<tr class="memitem:a87e36c479a52997171004152293e3376"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a87e36c479a52997171004152293e3376">getNumImages</a> ()</td></tr>
<tr class="memitem:a1c556c92011f510164aa9f28e13fd16f"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a1c556c92011f510164aa9f28e13fd16f">getCurrentImage</a> ()</td></tr>
<tr class="memitem:af6d6449ecd8fe9024965bd45cc45dd90"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#af6d6449ecd8fe9024965bd45cc45dd90">getFrameRate</a> () const </td></tr>
<tr class="inherit_header pub_methods_classflitr_1_1_image_producer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflitr_1_1_image_producer')"><img src="closed.png" alt="-"/>&nbsp;Public Member Functions inherited from <a class="el" href="classflitr_1_1_image_producer.html">flitr::ImageProducer</a></td></tr>
<tr class="memitem:a8583220986b69727f8f5a9ace9b19e5d inherit pub_methods_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#a8583220986b69727f8f5a9ace9b19e5d">ImageProducer</a> ()</td></tr>
<tr class="memitem:a6c3207104e7872fce9f98e5bd637b58b inherit pub_methods_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#a6c3207104e7872fce9f98e5bd637b58b">~ImageProducer</a> ()</td></tr>
<tr class="memitem:a9495277a8122ec0f7cfb63dc83ceb955 inherit pub_methods_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classflitr_1_1_image_format.html">ImageFormat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#a9495277a8122ec0f7cfb63dc83ceb955">getFormat</a> (uint32_t index=0)</td></tr>
<tr class="memitem:a5b34bbd15e5e3f50cec63bb4b7180356 inherit pub_methods_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#a5b34bbd15e5e3f50cec63bb4b7180356">getNumWriteSlotsAvailable</a> () const </td></tr>
<tr class="memitem:ada8987ae6f2e72ada31d702816b1e164 inherit pub_methods_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#ada8987ae6f2e72ada31d702816b1e164">getLeastNumReadSlotsAvailable</a> ()</td></tr>
<tr class="memitem:a2b781f13e6fdf65609fbb2ac3f6419c5 inherit pub_methods_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#a2b781f13e6fdf65609fbb2ac3f6419c5">setCreateMetadataFunction</a> (<a class="el" href="namespaceflitr.html#a4809c2cffdcf7a5370102b956fcd09dc">CreateMetadataFunction</a> f)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a25cf88a876746ee32a3e9a0fb0822860"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a25cf88a876746ee32a3e9a0fb0822860">filename_</a></td></tr>
<tr class="memitem:a3c28141186c2031ec5d48ea27fbe0e7c"><td class="memItemLeft" align="right" valign="top">std::tr1::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="classflitr_1_1_f_fmpeg_reader.html">FFmpegReader</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a3c28141186c2031ec5d48ea27fbe0e7c">Reader_</a></td></tr>
<tr class="memdesc:a3c28141186c2031ec5d48ea27fbe0e7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The reader to do the actual reading.  <a href="#a3c28141186c2031ec5d48ea27fbe0e7c"></a><br/></td></tr>
<tr class="memitem:a7f7155ff0184f22ee68926b44c881d84"><td class="memItemLeft" align="right" valign="top">std::tr1::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="classflitr_1_1_metadata_reader.html">MetadataReader</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a7f7155ff0184f22ee68926b44c881d84">MetadataReader_</a></td></tr>
<tr class="memitem:a6d2dd02e29ff7acc1a0bf894fa030f9d"><td class="memItemLeft" align="right" valign="top">std::tr1::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="classflitr_1_1_image_metadata.html">ImageMetadata</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a6d2dd02e29ff7acc1a0bf894fa030f9d">DefaultMetadata_</a></td></tr>
<tr class="memitem:ab87056f7ae51c130df3b3dba133bb947"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#ab87056f7ae51c130df3b3dba133bb947">NumImages_</a></td></tr>
<tr class="memdesc:ab87056f7ae51c130df3b3dba133bb947"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of frames in the file.  <a href="#ab87056f7ae51c130df3b3dba133bb947"></a><br/></td></tr>
<tr class="memitem:a4f900e07e23d46585fd316ff6a443690"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a4f900e07e23d46585fd316ff6a443690">CurrentImage_</a></td></tr>
<tr class="memdesc:a4f900e07e23d46585fd316ff6a443690"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last correctly read frame.  <a href="#a4f900e07e23d46585fd316ff6a443690"></a><br/></td></tr>
<tr class="memitem:a244b799415a610b8ec8f8e334fefaad1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a244b799415a610b8ec8f8e334fefaad1">buffer_size_</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classflitr_1_1_image_producer"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classflitr_1_1_image_producer')"><img src="closed.png" alt="-"/>&nbsp;Protected Member Functions inherited from <a class="el" href="classflitr_1_1_image_producer.html">flitr::ImageProducer</a></td></tr>
<tr class="memitem:a01eb729f570f48453719a037c4dd85d9 inherit pro_methods_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#a01eb729f570f48453719a037c4dd85d9">releaseReadSlotCallback</a> ()</td></tr>
<tr class="memitem:a3e642e35715da06dc327e71c92c6e848 inherit pro_methods_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#a3e642e35715da06dc327e71c92c6e848">addConsumer</a> (<a class="el" href="classflitr_1_1_image_consumer.html">ImageConsumer</a> &amp;consumer)</td></tr>
<tr class="memitem:a50cb5b2cd533974cddfa7561e2dd743a inherit pro_methods_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; <a class="el" href="classflitr_1_1_image.html">Image</a> ** &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#a50cb5b2cd533974cddfa7561e2dd743a">reserveWriteSlot</a> ()</td></tr>
<tr class="memitem:a5dd9a012d296b7bdb7df86d59f3f1b91 inherit pro_methods_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#a5dd9a012d296b7bdb7df86d59f3f1b91">releaseWriteSlot</a> ()</td></tr>
<tr class="inherit_header pro_attribs_classflitr_1_1_image_producer"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classflitr_1_1_image_producer')"><img src="closed.png" alt="-"/>&nbsp;Protected Attributes inherited from <a class="el" href="classflitr_1_1_image_producer.html">flitr::ImageProducer</a></td></tr>
<tr class="memitem:a72e945d24bb382258f9a0630fb48398a inherit pro_attribs_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classflitr_1_1_image_format.html">ImageFormat</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#a72e945d24bb382258f9a0630fb48398a">ImageFormat_</a></td></tr>
<tr class="memdesc:a72e945d24bb382258f9a0630fb48398a inherit pro_attribs_classflitr_1_1_image_producer"><td class="mdescLeft">&#160;</td><td class="mdescRight">A vector of the formats of the images is produced per slot.  <a href="#a72e945d24bb382258f9a0630fb48398a"></a><br/></td></tr>
<tr class="memitem:aab3c5af29ab27646422bb9c182be0464 inherit pro_attribs_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top">std::tr1::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="classflitr_1_1_shared_image_buffer.html">SharedImageBuffer</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#aab3c5af29ab27646422bb9c182be0464">SharedImageBuffer_</a></td></tr>
<tr class="memdesc:aab3c5af29ab27646422bb9c182be0464 inherit pro_attribs_classflitr_1_1_image_producer"><td class="mdescLeft">&#160;</td><td class="mdescRight">The shared buffer used for this producer and all consumers.  <a href="#aab3c5af29ab27646422bb9c182be0464"></a><br/></td></tr>
<tr class="memitem:a16f3600ed2852ed26b9d77bd760d897a inherit pro_attribs_classflitr_1_1_image_producer"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceflitr.html#a4809c2cffdcf7a5370102b956fcd09dc">CreateMetadataFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflitr_1_1_image_producer.html#a16f3600ed2852ed26b9d77bd760d897a">CreateMetadataFunction_</a></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Simple producer to read images from FFmpeg supported video files or still images. </p>
</div><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3a8f41dd8282de8faaef2d4fa580977e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FFmpegProducer::FFmpegProducer </td>
          <td>(</td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classflitr_1_1_image_format.html#a2bab1cfeef716117996a75550577efdc">ImageFormat::PixelFormat</a>&#160;</td>
          <td class="paramname"><em>out_pix_fmt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>buffer_size</em> = <code><a class="el" href="shared__image__buffer_8h.html#aac634152527964baab3ef9b764174e68">FLITR_DEFAULT_SHARED_BUFFER_NUM_SLOTS</a></code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Constructs the producer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>Video or image file name. </td></tr>
    <tr><td class="paramname">out_pix_fmt</td><td>The pixel format of the output. Whatever the actual input format, it will be converted to this requested format. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a1c556c92011f510164aa9f28e13fd16f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int32_t flitr::FFmpegProducer::getCurrentImage </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns the number of the last correctly read image.</p>
<dl class="section return"><dt>Returns</dt><dd>0 to <a class="el" href="classflitr_1_1_f_fmpeg_producer.html#a87e36c479a52997171004152293e3376">getNumImages()</a>-1 for valid frames or -1 when not successfully triggered. </dd></dl>

</div>
</div>
<a class="anchor" id="af6d6449ecd8fe9024965bd45cc45dd90"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t flitr::FFmpegProducer::getFrameRate </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Get the frame rate of the video.</p>
<dl class="section return"><dt>Returns</dt><dd>Frame rate. </dd></dl>

</div>
</div>
<a class="anchor" id="a87e36c479a52997171004152293e3376"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t flitr::FFmpegProducer::getNumImages </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns the number of frames in the file.</p>
<dl class="section return"><dt>Returns</dt><dd>Number of frames. </dd></dl>

</div>
</div>
<a class="anchor" id="a7b690142fd60cd615253bff0fb0f3ebc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool FFmpegProducer::init </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>The init method is used after construction to be able to return success or failure of opening the file.</p>
<dl class="section return"><dt>Returns</dt><dd>True if successful. </dd></dl>

<p>Implements <a class="el" href="classflitr_1_1_image_producer.html#a0bb6c0260a3bf3f4da7e362f579db4c9">flitr::ImageProducer</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classflitr_1_1_f_fmpeg_producer_a7b690142fd60cd615253bff0fb0f3ebc_cgraph.png" border="0" usemap="#classflitr_1_1_f_fmpeg_producer_a7b690142fd60cd615253bff0fb0f3ebc_cgraph" alt=""/></div>
<map name="classflitr_1_1_f_fmpeg_producer_a7b690142fd60cd615253bff0fb0f3ebc_cgraph" id="classflitr_1_1_f_fmpeg_producer_a7b690142fd60cd615253bff0fb0f3ebc_cgraph">
<area shape="rect" id="node3" href="namespaceflitr.html#ade64a6ebeb22a24d7202a8c9cd8dceb2" title="Actually log." alt="" coords="204,59,321,88"/><area shape="rect" id="node5" href="namespaceflitr.html#ab607eb6aa8d6055d192b78f2d635c2d8" title="Init the flags." alt="" coords="371,59,509,88"/><area shape="rect" id="node7" href="log__message_8cpp.html#a60c5c2565f195f3f6e4aefd629a74d26" title="setInEnvironment" alt="" coords="595,5,717,35"/><area shape="rect" id="node9" href="namespaceflitr.html#ab8702f45e18dd67adc18d12db04b4853" title="Add flags." alt="" coords="559,59,753,88"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a5dcce214520a811994878e2ed32d91a7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool FFmpegProducer::seek </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>position</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Reads a specified frame from the file.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">position</td><td>Frame number to read (0 based).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if a frame was successfully read. </dd></dl>

<p>Reimplemented from <a class="el" href="classflitr_1_1_image_producer.html#a636b354578c50ba0ca2b7bd4f98842fc">flitr::ImageProducer</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classflitr_1_1_f_fmpeg_producer_a5dcce214520a811994878e2ed32d91a7_cgraph.png" border="0" usemap="#classflitr_1_1_f_fmpeg_producer_a5dcce214520a811994878e2ed32d91a7_cgraph" alt=""/></div>
<map name="classflitr_1_1_f_fmpeg_producer_a5dcce214520a811994878e2ed32d91a7_cgraph" id="classflitr_1_1_f_fmpeg_producer_a5dcce214520a811994878e2ed32d91a7_cgraph">
<area shape="rect" id="node3" href="classflitr_1_1_image_producer.html#a50cb5b2cd533974cddfa7561e2dd743a" title="flitr::ImageProducer\l::reserveWriteSlot" alt="" coords="217,5,353,51"/><area shape="rect" id="node5" href="classflitr_1_1_image.html#a964075cb13a8133d9f1842d318d1f65c" title="flitr::Image::setMetadata" alt="" coords="204,75,367,104"/><area shape="rect" id="node7" href="classflitr_1_1_image_producer.html#a5dd9a012d296b7bdb7df86d59f3f1b91" title="flitr::ImageProducer\l::releaseWriteSlot" alt="" coords="217,127,353,174"/></map>
</div>
</p>

<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classflitr_1_1_f_fmpeg_producer_a5dcce214520a811994878e2ed32d91a7_icgraph.png" border="0" usemap="#classflitr_1_1_f_fmpeg_producer_a5dcce214520a811994878e2ed32d91a7_icgraph" alt=""/></div>
<map name="classflitr_1_1_f_fmpeg_producer_a5dcce214520a811994878e2ed32d91a7_icgraph" id="classflitr_1_1_f_fmpeg_producer_a5dcce214520a811994878e2ed32d91a7_icgraph">
<area shape="rect" id="node3" href="classflitr_1_1_f_fmpeg_producer.html#a2dd4099b87c7bc4e3593c54d972139a2" title="flitr::FFmpegProducer\l::trigger" alt="" coords="204,5,351,51"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="abef2ab1f44dc9fb5a0a351656c61b0fd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool FFmpegProducer::setAutoLoadMetaData </td>
          <td>(</td>
          <td class="paramtype">std::tr1::shared_ptr&lt; <a class="el" href="classflitr_1_1_image_metadata.html">ImageMetadata</a> &gt;&#160;</td>
          <td class="paramname"><em>defaultMetadata</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a2dd4099b87c7bc4e3593c54d972139a2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool FFmpegProducer::trigger </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Reads the next frame from the file and make it available. If the file reached the end, reading is resumed from the start.</p>
<dl class="section return"><dt>Returns</dt><dd>True if a frame was successfully read. </dd></dl>

<p>Reimplemented from <a class="el" href="classflitr_1_1_image_producer.html#af86fed83f474ab9889ab9502776908b8">flitr::ImageProducer</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classflitr_1_1_f_fmpeg_producer_a2dd4099b87c7bc4e3593c54d972139a2_cgraph.png" border="0" usemap="#classflitr_1_1_f_fmpeg_producer_a2dd4099b87c7bc4e3593c54d972139a2_cgraph" alt=""/></div>
<map name="classflitr_1_1_f_fmpeg_producer_a2dd4099b87c7bc4e3593c54d972139a2_cgraph" id="classflitr_1_1_f_fmpeg_producer_a2dd4099b87c7bc4e3593c54d972139a2_cgraph">
<area shape="rect" id="node3" href="classflitr_1_1_f_fmpeg_producer.html#a5dcce214520a811994878e2ed32d91a7" title="flitr::FFmpegProducer\l::seek" alt="" coords="204,66,351,113"/><area shape="rect" id="node5" href="classflitr_1_1_image_producer.html#a50cb5b2cd533974cddfa7561e2dd743a" title="flitr::ImageProducer\l::reserveWriteSlot" alt="" coords="415,5,551,51"/><area shape="rect" id="node7" href="classflitr_1_1_image.html#a964075cb13a8133d9f1842d318d1f65c" title="flitr::Image::setMetadata" alt="" coords="401,75,564,104"/><area shape="rect" id="node9" href="classflitr_1_1_image_producer.html#a5dd9a012d296b7bdb7df86d59f3f1b91" title="flitr::ImageProducer\l::releaseWriteSlot" alt="" coords="415,127,551,174"/></map>
</div>
</p>

</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="a244b799415a610b8ec8f8e334fefaad1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t flitr::FFmpegProducer::buffer_size_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a4f900e07e23d46585fd316ff6a443690"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int32_t flitr::FFmpegProducer::CurrentImage_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Last correctly read frame. </p>

</div>
</div>
<a class="anchor" id="a6d2dd02e29ff7acc1a0bf894fa030f9d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::tr1::shared_ptr&lt;<a class="el" href="classflitr_1_1_image_metadata.html">ImageMetadata</a>&gt; flitr::FFmpegProducer::DefaultMetadata_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a25cf88a876746ee32a3e9a0fb0822860"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::string flitr::FFmpegProducer::filename_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a7f7155ff0184f22ee68926b44c881d84"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::tr1::shared_ptr&lt;<a class="el" href="classflitr_1_1_metadata_reader.html">MetadataReader</a>&gt; flitr::FFmpegProducer::MetadataReader_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ab87056f7ae51c130df3b3dba133bb947"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t flitr::FFmpegProducer::NumImages_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Number of frames in the file. </p>

</div>
</div>
<a class="anchor" id="a3c28141186c2031ec5d48ea27fbe0e7c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::tr1::shared_ptr&lt;<a class="el" href="classflitr_1_1_f_fmpeg_reader.html">FFmpegReader</a>&gt; flitr::FFmpegProducer::Reader_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The reader to do the actual reading. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/flitr/<a class="el" href="ffmpeg__producer_8h_source.html">ffmpeg_producer.h</a></li>
<li>src/flitr/<a class="el" href="ffmpeg__producer_8cpp.html">ffmpeg_producer.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceflitr.html">flitr</a></li><li class="navelem"><a class="el" href="classflitr_1_1_f_fmpeg_producer.html">FFmpegProducer</a></li>
    <li class="footer">Generated on Thu Dec 6 2012 09:15:45 for FLITr by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.2 </li>
  </ul>
</div>
</body>
</html>
